Developer Environment Startup Guide

The Startup tab is designed to provide the user with quick access to common tasks such as creating a new project, opening existing projects, and importing projects from files.

Functions available in this tab are listed below.

Create New Blank Project

This function is used to create a new project in the developer interface. When clicked, a dialog box appears where the project details can be entered.

The screen contains the following fields:

1. Project Name: The user must give the project a name. This field is mandatory.
2. Title: The title of the project visible to users. Optional, but it helps in making the project more understandable.
3. Save Location (DM): The directory where the project will be saved must be selected. This is also a mandatory field, and the directory must be specified in the document management system.

After entering the required details, clicking the Create button will create the new project. The created project will automatically open.

Create Project from Template

Instead of creating a blank project, it is possible to create a new project with predefined information by selecting one of the predefined templates in the system. When the "Create Project from Template" option is clicked, a screen listing the templates appears.

Template projects are listed in card form on the screen.

1. Sorting: Sorting can be done alphabetically from the sorting menu in the upper-right corner.

2. Search Function: The template list can be filtered using the search function. You can quickly find projects with specific template names by typing in the search box.

3. Template Selection: By clicking on the relevant template, a new project will be created based on the structure of the chosen template.

After selecting one of the templates, the structure of the template will be applied to the new project. The project creation wizard will then open.

1. Target: Project name and file path selection is made.

2. Analysis: The content of the project file is analyzed. The components in the project file are reviewed and listed on the screen in groups.

3. DM (Document Management): Documents and templates in the transferred project are selected. In this step, documents or templates in the document management system must be matched with the project. If components from the template project exist in the environment being transferred to, automatic matching is provided. For unmatched components, the appropriate counterparts must be selected.

4. Links: The links in the project are checked to ensure they can be correctly linked in the transferred environment. If the links from the template project exist in the environment being transferred to, automatic matching is provided. For unmatched links, the appropriate counterparts must be selected.

5. HR: HR components are checked and adjusted for transfer. If the components from the template project exist in the environment being transferred to, automatic matching is provided. For unmatched components, the appropriate counterparts must be selected.

6. Forms: The forms in the project are matched with their counterparts in the system. If the forms from the template project exist in the environment being transferred to, automatic matching is provided. For unmatched forms, the appropriate counterparts must be selected.

7. Flows: The flows in the project are matched with their counterparts in the system. If the flows from the template project exist in the environment being transferred to, automatic matching is provided. For unmatched flows, the appropriate counterparts must be selected.

   

8. PAT: The necessary PAT keys for scheduled tasks are matched in this step. If the PAT key from the template project exists in the environment being transferred to, automatic matching is provided. For unmatched information, the appropriate counterparts must be selected.

   

9. Create Project: In the last step, all settings are adjusted and the project is transferred to the system. Clicking the Next button starts the project creation process.

Once all steps are completed, the created project will automatically open.

Import Project from File

Project Import Process

The project import process is used to integrate an exported project into the same or a different Synergy environment. During the process, the components of the project are matched with their counterparts in the system.

The import process is carried out through the following steps:

1. Opening the Import Modal

   • The modal is opened by clicking "Import Project" → "Import Project from File" via the Tools Menu, Startup Panel, or the top-left menu.

2. Selecting the Source

   • In the first step, the .tar.gz project file is selected. The user can choose either Select from Computer or Select from Document Management.

     

3. Defining the Target

   • A new project name is defined or an existing project is selected for overwriting.

     

4. Analysis

   • The selected project is analyzed. The components in the project files are reviewed and listed on the screen in groups.

     

5. DM Objects (Document Management)

   • Documents and templates in the transferred project are selected. At this step, items in the document management system must be matched with the project. If components already exist in the target environment, they are matched automatically. Unmatched items must be matched manually.

     

6. Connections

   • Data sources in the project are checked to ensure they can be correctly matched in the target environment. Automatic matching is performed if the data sources exist; otherwise, manual matching is required.

     

7. HR Objects

   • HR-related elements such as users, positions, titles, and departments are matched. If matching records exist, they are matched automatically. Otherwise, manual selection is required.

     

8. Forms

   • Form templates defined in the project are matched with their counterparts in the system. If no match is found, the appropriate one must be selected manually.

     

9. Flows

   • Flows in the project are matched with those in the system. Automatic or manual selection may be used as needed.

     

10. PAT (Personnel Access Token)

    • Access tokens used in the project are matched with existing PATs in the system.
    • If no match is found, a new PAT can be created.
    • The import process cannot be completed without PAT matching.

    

11. Import and Publish

    • The process is started by clicking the "Import" button.

    • Optionally, the project can be published after the import is completed (as Major or Minor version).

    • A Deploy Agent can be selected to handle the publishing process.

      

Authorization and Requirements

• The following permissions are required to perform the import process:
  • Synergy IDE Access: The user must have permission to access the IDE interface.
  • Project Management: The user must belong to a group that has permission to manage projects.

Notes

• The project to be imported must have a .tar.gz extension.
• If the project is encrypted, the password must be provided during the import process.
• Projects can only be imported into Synergy CSP environments. Compatibility between the source and target versions should be considered, as incompatibility may lead to import issues.
• Any errors or mismatches found during the analysis step must be resolved before the import can proceed.
• Once the import is complete, the project will open automatically.
• The project can be published automatically after import, based on user preference.

Open Existing Project

The Open Existing Project option is used to open and continue working on existing projects. When clicked, the project manager screen opens.

The screen contains the following information:

1. Project List: The list contains all available projects. These could be projects that belong to the user or projects for which the user has access permissions.
2. Search Function: You can easily find the project you need by searching in the project list.
3. Sorting: Sorting can be done based on project name, path, and creation date.
4. Project Selection: By clicking on the project name, the latest version of the project can be opened. Additionally, a menu will appear when hovering over the project name, allowing a specific version to be selected.
5. Password Protected Projects: If a project is password protected, a lock icon will appear next to the project name. To open these projects, the correct password must be entered. Once the correct password is entered, the project will open.

Related Notes

• Selecting Projects from Templates: During template selection, the search and sorting functions help quickly find the right template.
• Project Import: During the import process, special attention must be paid to steps like DM (Document Management) and Flows, as they require careful review and adjustment.

See Also

• [Development Environment (IDE) Permissions](../../../User Guides/AdministrativeTools/Security/IDE/IDE.md)
• Export a Project
• [IDE (Integrated Development Environment)](../../../User Guides/AdministrativeTools/IDE/IDE.md)
• Developer Environment Startup Guide
• [Development Environment (IDE) Permissions](../../../User Guides/AdministrativeTools/Security/IDE/IDE.md)
• Import a Project
• Export a Project
• [IDE (Integrated Development Environment)](../../../User Guides/AdministrativeTools/IDE/IDE.md)

FAQs

• How Can I Search for a Template?
• How Can I Open a Password-Protected Project?
• What is the Purpose of the Project Transfer Wizard?
• How Can I Sort Project Templates?
• What is the IDE Startup Tab?
• Can I Create a Project from a Template?
• Can I Change the Order of Components During Import?
• What Are the Required Fields for Creating a New Project?

How To's

• Sorting Templates in the Project Creation Wizard
• Importing a Project from a File
• Matching Components During Project Import
• Creating a New Blank Project
• Handling Password-Protected Projects
• Creating a Project from a Template
• Using the Search Function in Project Templates
• Opening an Existing Project